Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
please-upgrade-node
Advanced tools
Displays a beginner-friendly message telling your user to upgrade their version of Node
The please-upgrade-node package is designed to help Node.js developers ensure that their applications are run with a minimum required version of Node.js. It provides a simple way to enforce a version constraint, displaying a message to users to upgrade their Node.js version if the current environment does not meet the specified requirements. This is particularly useful for CLI tools or applications where the developer wants to prevent execution in unsupported Node.js environments.
Enforcing minimum Node.js version
This feature allows developers to specify a minimum Node.js version requirement in their package.json file. When the application or tool is run, please-upgrade-node checks the current Node.js version against the specified minimum version. If the current version is lower, it displays a message urging the user to upgrade their Node.js installation. The 'pkg' variable represents the package.json of the application, which should include a 'engines' field specifying the required Node.js version.
require('please-upgrade-node')(pkg)
Similar to please-upgrade-node, check-node-version allows developers to specify version requirements for Node.js, npm, and Yarn. It can be used as a command-line tool or integrated into scripts. Unlike please-upgrade-node, which is focused solely on Node.js versions, check-node-version provides broader version checking capabilities, making it suitable for projects that also need to enforce npm or Yarn version constraints.
engine-check is another package that offers functionality similar to please-upgrade-node by enforcing engine version requirements specified in the package.json file. It can be used as a preinstall or prestart script to ensure that the Node.js environment meets the specified version requirements before proceeding. Compared to please-upgrade-node, engine-check provides a more automated approach to version enforcement, directly integrating with npm lifecycle scripts.
Be friendly, be cool :sunglasses: show a message to your users to upgrade Node instead of a stacktrace
It's common for new Node users to miss the npm
engines warning when installing a CLI. This package displays a beginner-friendly message if their Node version is below the one expected and it's just a few lines of JS code.
Example with hotel CLI:
$ node -v
0.12
$ hotel
hotel requires at least version 4 of Node, please upgrade
Install:
npm install please-upgrade-node
yarn add please-upgrade-node
Require please-upgrade-node
before anything else:
// bin.js
require('please-upgrade-node')(
require('./package.json')
)
// The rest of your code...
In your package.json
, define the required Node version:
{
"name": "super-cli",
"bin": "./bin.js",
"engines": { "node": ">=6" }
}
Please note that >=
is the only operator supported by please-upgrade-node
(e.g. >=4
, >=4.0
, >=4.0.0
). Now if your users install your super-cli
project with an older Node version, they'll see:
$ npm install -g super-cli
# [...]
npm WARN engine super-cli@1.0.0: : wanted: {"node":">=6"} (current: {"node":"4.8.3","npm":"2.15.11"})
# [...]
$ super-cli
super-cli requires at least version 6 of Node, please upgrade
Make sure when requiring please-upgrade-node
to not use syntax that is only supported in recent versions of Node.
For example, if you use const
instead of var
and don't transpile it, please-upgrade-node
won't work with Node 0.12
:
const pkg = require('./package.json') // ← Will fail and exit here with Node 0.12,
// because const isn't supported.
require('please-upgrade-node')(pkg) // No upgrade message will be displayed :(
Thanks to zeit/serve for inspiring the error message.
MIT - Typicode :cactus: - Patreon
FAQs
Displays a beginner-friendly message telling your user to upgrade their version of Node
The npm package please-upgrade-node receives a total of 3,155,890 weekly downloads. As such, please-upgrade-node popularity was classified as popular.
We found that please-upgrade-node demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.